Function Reference

_AD_RenameObject

Renames an object within an OU.

#Include <AD.au3>
_AD_RenameObject($sObject, $sCN)

 

Parameters

$sObject Object (user, group, computer) to rename (FQDN or sAMAccountName)
$sCN New Name (relative name) of the object in the current OU without CN=

 

Return Value

Success: 1
Failure: 0, sets @error to:
    1 - $sObject does not exist
    x - Error returned by MoveHere function (Missing permission etc.)

 

Remarks

Renames an object within the same OU. You can not move objects to another OU with this function.

 

Related

_AD_MoveObject, _AD_DeleteObject

 

See Also

http://msdn.microsoft.com/en-us/library/aa705991(v=VS.85).aspx

 

Example


#AutoIt3Wrapper_AU3Check_Parameters= -d -w 1 -w 2 -w 3 -w 4 -w 5 -w 6
#AutoIt3Wrapper_AU3Check_Stop_OnWarning=Y
; *****************************************************************************
; Example 1
; Renames an AD object.
; *****************************************************************************
#include <AD.au3>
#include <ButtonConstants.au3>
#include <GUIConstantsEx.au3>
#include <WindowsConstants.au3>

; Open Connection to the Active Directory
_AD_Open()
If @error Then Exit MsgBox(16, "Active Directory Example Skript", "Function _AD_Open encountered a problem. @error = " & @error & ", @extended = " & @extended)

Global $iReply = MsgBox(308, "Active Directory Functions - Example 1", "This script renames an object in the AD (user, group ...)." & @CRLF & @CRLF & _
        "Are you sure you want to change the Active Directory?")
If $iReply <> 6 Then Exit

; Enter object to rename and new name
#region ### START Koda GUI section ### Form=
Global $Form1 = GUICreate("Active Directory Functions - Example 1", 814, 124)
GUICtrlCreateLabel("Object to rename (FQDN or sAMAccountName):", 8, 10, 231, 17)
GUICtrlCreateLabel("New name (without leading CN=):", 8, 42, 231, 17)
Global $IObject = GUICtrlCreateInput(_AD_SamAccountNameToFQDN(@UserName), 241, 8, 559, 21)
Global $INewName = GUICtrlCreateInput("", 241, 40, 559, 21)
Global $BOK = GUICtrlCreateButton("Rename object", 8, 72, 130, 33)
Global $BCancel = GUICtrlCreateButton("Cancel", 728, 72, 73, 33, BitOR($GUI_SS_DEFAULT_BUTTON, $BS_DEFPUSHBUTTON))
GUISetState(@SW_SHOW)
#endregion ### END Koda GUI section ###

While 1
    Global $nMsg = GUIGetMsg()
    Switch $nMsg
        Case $GUI_EVENT_CLOSE, $BCancel
            Exit
        Case $BOK
            Global $sObject = GUICtrlRead($IObject)
            Global $sNewName = GUICtrlRead($INewName)
            ExitLoop
    EndSwitch
WEnd

; Rename object
Global $iValue = _AD_RenameObject($sObject, $sNewName)
If $iValue = 1 Then
    MsgBox(64, "Active Directory Functions - Example 1", "Object '" & $sObject & "' successfully renamed")
ElseIf @error = 1 Then
    MsgBox(64, "Active Directory Functions - Example 1", "Object '" & $sObject & "' does not exist")
Else
    MsgBox(64, "Active Directory Functions - Example 1", "Return code '" & @error & "' from Active Directory")
EndIf

; Close Connection to the Active Directory
_AD_Close()